add a guide how to declare plugin typings #1042
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HerringtonDarkholme
approved these changes
Jul 24, 2017
src/v2/guide/typescript.md
Outdated
|
|
||
| ## Declaring Types of Vue Plugins | ||
|
|
||
| Plugins may augment Vue's global/instance properties, component options and so on. For that case, augmenting type declaration is also needed to use plugins in TypeScript. Fortunately, there is a feature to augment an existing types that is called [module augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation). |
There was a problem hiding this comment.
augment appears three times in this paragraph, which reads quite wordy. Also augment is rather an abstract term, so it is quite hard for TypeScript new comers.
I would suggest change some verbs:
Plugins may add Vue's global/instance properties, component options and so on. For that case, type declaration also needs updates to make plugins code compile in TypeScript.
add and update explains what augment does before we introduce the TS feature. I think this should be clearer for ordinary Vue users.
There was a problem hiding this comment.
Thanks for the suggestion 👍 Updated!
|
@ktsn Looks great! I just made some small tweaks to the wording. |
kazupon
pushed a commit
to kazupon/vuejs.org
that referenced
this pull request
Oct 1, 2017
* add a guide how to declare plugin typings (vuejs#1042) * add a guide how to declare plugin typings * improve wording * Slight tweak to working for declaring typescript types for plugins * Translate declaring types of vue plugins * Update the updated field in ts guide
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm seeing some users struggling how to declare typings for plugins (e.g. vuejs/vue-class-component#128), especially the plugin that augments instance property/component options. I think it can be tricky because we have to use a feature that most of ts users may not know.
This PR adds an example code to do that. I think it would be helpful not only for plugin developers but also users that uses a plugin not include typings since they can know how to make it by themselves.